EditControllerEx1 Class Reference
[VST Implementation Helper Classes]

Advanced implementation (support IUnitInfo) for a VST 3 edit controller. More...

#include <vsteditcontroller.h>

Inheritance diagram for EditControllerEx1:
Inheritance graph
[legend]

Public Member Functions

 EditControllerEx1 ()
virtual ~EditControllerEx1 ()
bool addUnit (Unit *unit)
 Adds a given unit.
bool addProgramList (ProgramList *list)
 Adds a given program list.
ProgramListgetProgramList (ProgramListID listId) const
 Returns the ProgramList associated to a given listId.
tresult notifyPogramListChange (ProgramListID listId, int32 programIndex=kAllProgramInvalid)
 Notifies the host about program list changes.
virtual int32 getUnitCount ()
virtual tresult getUnitInfo (int32 unitIndex, UnitInfo &info)
virtual int32 getProgramListCount ()
virtual tresult getProgramListInfo (int32 listIndex, ProgramListInfo &info)
virtual tresult getProgramName (ProgramListID listId, int32 programIndex, String128 name)
virtual tresult getProgramInfo (ProgramListID listId, int32 programIndex, CString attributeId, String128 attributeValue)
virtual tresult hasProgramPitchNames (ProgramListID listId, int32 programIndex)
virtual tresult getProgramPitchName (ProgramListID listId, int32 programIndex, int16 midiPitch, String128 name)
virtual tresult setProgramName (ProgramListID listId, int32 programIndex, const String128 name)
virtual UnitID getSelectedUnit ()
virtual tresult selectUnit (UnitID unitId)
virtual tresult getUnitByBus (MediaType, BusDirection, int32, int32, UnitID &)
virtual tresult setUnitProgramData (int32, int32, IBStream *)
virtual tresult notifyUnitSelection ()
 Notifies the host about the selected Unit.
virtual void update (FUnknown *changedUnknown, int32 message)

Data Fields

OBJ_METHODS(EditControllerEx1,
EditController)
DEFINE_INTERFACES
DEF_INTERFACE(IUnitInfo)
END_DEFINE_INTERFACES(EditController)
REFCOUNT_METHODS(EditController)
protected TDictionary
< ProgramListID, IPtr
< ProgramList > > 
programLists
UnitID selectedUnit

Detailed Description

Advanced implementation (support IUnitInfo) for a VST 3 edit controller.


Constructor & Destructor Documentation

~EditControllerEx1 (  )  [virtual]

Member Function Documentation

bool addUnit ( Unit unit  ) 

Adds a given unit.

bool addProgramList ( ProgramList list  ) 

Adds a given program list.

ProgramList * getProgramList ( ProgramListID  listId  )  const

Returns the ProgramList associated to a given listId.

tresult notifyPogramListChange ( ProgramListID  listId,
int32  programIndex = kAllProgramInvalid 
)

Notifies the host about program list changes.

virtual int32 getUnitCount (  )  [inline, virtual]

Implements IUnitInfo.

tresult getUnitInfo ( int32  unitIndex,
UnitInfo info 
) [virtual]

Implements IUnitInfo.

int32 getProgramListCount (  )  [virtual]

Implements IUnitInfo.

tresult getProgramListInfo ( int32  listIndex,
ProgramListInfo info 
) [virtual]

Implements IUnitInfo.

tresult getProgramName ( ProgramListID  listId,
int32  programIndex,
String128  name 
) [virtual]

Implements IUnitInfo.

tresult getProgramInfo ( ProgramListID  listId,
int32  programIndex,
CString  attributeId,
String128  attributeValue 
) [virtual]

Implements IUnitInfo.

tresult hasProgramPitchNames ( ProgramListID  listId,
int32  programIndex 
) [virtual]

Implements IUnitInfo.

tresult getProgramPitchName ( ProgramListID  listId,
int32  programIndex,
int16  midiPitch,
String128  name 
) [virtual]

Implements IUnitInfo.

tresult setProgramName ( ProgramListID  listId,
int32  programIndex,
const String128  name 
) [virtual]
virtual UnitID getSelectedUnit (  )  [inline, virtual]

Implements IUnitInfo.

virtual tresult selectUnit ( UnitID  unitId  )  [inline, virtual]

Implements IUnitInfo.

virtual tresult getUnitByBus ( MediaType  ,
BusDirection  ,
int32  ,
int32  ,
UnitID  
) [inline, virtual]

Implements IUnitInfo.

virtual tresult setUnitProgramData ( int32  ,
int32  ,
IBStream  
) [inline, virtual]

Implements IUnitInfo.

tresult notifyUnitSelection (  )  [virtual]

Notifies the host about the selected Unit.

void update ( FUnknown changedUnknown,
int32  message 
) [virtual]

Field Documentation

OBJ_METHODS (EditControllerEx1, EditController) DEFINE_INTERFACES DEF_INTERFACE (IUnitInfo) END_DEFINE_INTERFACES (EditController) REFCOUNT_METHODS(EditController) protected TDictionary<ProgramListID, IPtr<ProgramList> > programLists
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Defines
Empty

Copyright ©2013 Steinberg Media Technologies GmbH. All Rights Reserved.